API

Logistics APIs

PUT logistics/shipping-services/{shippingServiceId}

Updates a shipping service

HTTP method PUT
URI https://api.rambase.net/logistics/shipping-services/{shippingServiceId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {shippingServiceId} Shipping service identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 4036, version 6

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<ShippingService
ShippingService

This field is optional.

>
2
     <Name
Name

Name of shipping service

This field is optional.

>{String}</Name>
3
     <Description
Description

Description of shipping service

This field is optional.

>{String}</Description>
4
     <Direction
Direction

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Applicable domain values can be found here

This field is optional.

>{String}</Direction>
5
     <IsAvailableExternal
IsAvailableExternal

True if shipping service should be visibile in external systems. An example of an external system might be a web site.

This field is optional.

>{Boolean}</IsAvailableExternal>
6
     <DepartingWaybillConsolidationTag
DepartingWaybillConsolidationTag

All shipping services with same consolidation tag will be consolidated when creating departing waybills for shipping advices, supplier returns and goods transfers. Example of consolidation tag might be "UPSNORDIC".

This field is optional.

>{String}</DepartingWaybillConsolidationTag>
7
     <PayersCustomerIdAtCarrier
PayersCustomerIdAtCarrier

Customers account ID at the carrier for the given shippingservice

This field is optional.

>{String}</PayersCustomerIdAtCarrier>
8
     <PayersCustomerIdAtReturnCarrier
PayersCustomerIdAtReturnCarrier

The customer account id (at the carrier) that should pay for return of shipments sihpped with this shipping service. It is typically the customer.

This field is optional.

>{String}</PayersCustomerIdAtReturnCarrier>
9
     <Carrier
Carrier

This field is optional.

>
10
          <CarrierId
CarrierId

Carrier identifier

Minimum value: 1000

This field is optional.

>{Integer}</CarrierId>
11
     </Carrier>
12
     <CarrierService
CarrierService

This field is optional.

>
13
          <CarrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

Minimum value: 1

This field is optional.

>{Integer}</CarrierServiceId>
14
     </CarrierService>
15
     <ExclusivelyForCustomer
ExclusivelyForCustomer

Some shipping services are exclusively for one customer only.

This field is optional.

>
16
          <CustomerId
CustomerId

Customer identifier

Minimum value: 1000

This field is optional.

>{Integer}</CustomerId>
17
     </ExclusivelyForCustomer>
18
     <ReturnShippingService
ReturnShippingService

The shipping service that should be used when shipments that are shipped with this shipping service are returned. For instance you might not have to use an expensive express delivery for the return of products.

This field is optional.

>
19
          <ShippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

>{Integer}</ShippingServiceId>
20
     </ReturnShippingService>
21
</ShippingService>
1
{
2
     "shippingService
ShippingService

This field is optional.

": {
3
          "name
Name

Name of shipping service

This field is optional.

": "{String}",
4
          "description
Description

Description of shipping service

This field is optional.

": "{String}",
5
          "direction
Direction

Direction of goods for this shipping service. Is goods arriving by this shipping service (INCOMING), or is departing (OUTGOING).

Applicable domain values can be found here

This field is optional.

": "{String}",
6
          "isAvailableExternal
IsAvailableExternal

True if shipping service should be visibile in external systems. An example of an external system might be a web site.

This field is optional.

": "{Boolean}",
7
          "departingWaybillConsolidationTag
DepartingWaybillConsolidationTag

All shipping services with same consolidation tag will be consolidated when creating departing waybills for shipping advices, supplier returns and goods transfers. Example of consolidation tag might be "UPSNORDIC".

This field is optional.

": "{String}",
8
          "payersCustomerIdAtCarrier
PayersCustomerIdAtCarrier

Customers account ID at the carrier for the given shippingservice

This field is optional.

": "{String}",
9
          "payersCustomerIdAtReturnCarrier
PayersCustomerIdAtReturnCarrier

The customer account id (at the carrier) that should pay for return of shipments sihpped with this shipping service. It is typically the customer.

This field is optional.

": "{String}",
10
          "carrier
Carrier

This field is optional.

": {
11
               "carrierId
CarrierId

Carrier identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
12
          },
13
          "carrierService
CarrierService

This field is optional.

": {
14
               "carrierServiceId
CarrierServiceId

Shipping service identifier from arhive for shipping services

Minimum value: 1

This field is optional.

": "{Integer}"
15
          },
16
          "exclusivelyForCustomer
ExclusivelyForCustomer

Some shipping services are exclusively for one customer only.

This field is optional.

": {
17
               "customerId
CustomerId

Customer identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
18
          },
19
          "returnShippingService
ReturnShippingService

The shipping service that should be used when shipments that are shipped with this shipping service are returned. For instance you might not have to use an expensive express delivery for the return of products.

This field is optional.

": {
20
               "shippingServiceId
ShippingServiceId

Shipping service identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
21
          }
22
     }
23
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return:

Error 101079 HTTP 400 Mismatch in size of revision parameters
Error 101370 HTTP 400 Cannot change carrier of an active (status 4) shipping service
Error 101404 HTTP 400 Cannot change direction of an active (status 4) shipping service
Error 101528 HTTP 400 Cannot change customer 0f an active (status 4) shipping Service
Error 101310 HTTP 400 Name of shipping service is required
Error 101311 HTTP 400 Direction of the shipping service is required